/*
 * Copyright (c) 2009 Frederic Daoud
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package org.stripesbook.rayures.view.stripes;

import net.sourceforge.stripes.tag.FormatTag;
import org.stripesbook.rayures.exception.RequiredTagAttributeException;

/**
 * Corresponds to {@link FormatTag} and {@code <s:format>}.
 * Also see {@link org.stripesbook.rayures.view.util.Formatter} for more formatting methods; an instance of
 * this class is automatically made available to view templates via
 * ${@value org.stripesbook.rayures.util.Constants#ATTR_FORMATTER}.
 *
 * @author Frederic Daoud
 */
public class SFormat extends SVarTagSupport<FormatTag, SFormat> {
  public SFormat() {
    super(new FormatTag());
  }

  @Override
  protected void validate() throws RequiredTagAttributeException {
    if (getTag().getValue() == null) {
      throw new RequiredTagAttributeException("SFormat: value() must be specified.");
    }
  }

  public SFormat formatPattern(String formatPattern) {
    getTag().setFormatPattern(formatPattern);
    return getThis();
  }

  public SFormat formatType(String formatType) {
    getTag().setFormatType(formatType);
    return getThis();
  }

  public SFormat value(Object value) {
    getTag().setValue(value);
    return getThis();
  }
}
